core/androidx.core.view/[main]NestedScrollingParentHelper

NestedScrollingParentHelper

open class NestedScrollingParentHelper(source)

Helper class for implementing nested scrolling parent views compatible with Android platform versions earlier than Android 5.0 Lollipop (API 21).

ViewGroup subclasses should instantiate a final instance of this class as a field at construction. For each ViewGroup method that has a matching method signature in this class, delegate the operation to the helper instance in an overridden method implementation. This implements the standard framework policy for nested scrolling.

Views invoking nested scrolling functionality should always do so from the relevant androidx.core.view.ViewCompat, androidx.core.view.ViewGroupCompat or androidx.core.view.ViewParentCompat compatibility shim static methods. This ensures interoperability with nested scrolling views on Android 5.0 Lollipop and newer.

Constructors

NestedScrollingParentHelper

constructor(@NonNull viewGroup: ViewGroup)

Construct a new helper for a given ViewGroup

Functions

getNestedScrollAxes

open fun getNestedScrollAxes(): Int

Return the current axes of nested scrolling for this ViewGroup.

onNestedScrollAccepted

open fun onNestedScrollAccepted(@NonNull child: View, @NonNull target: View, axes: Int)

open fun onNestedScrollAccepted(@NonNull child: View, @NonNull target: View, axes: Int, type: Int)

Called when a nested scrolling operation initiated by a descendant view is accepted by this ViewGroup.

onStopNestedScroll

open fun onStopNestedScroll(@NonNull target: View)

open fun onStopNestedScroll(@NonNull target: View, type: Int)

React to a nested scroll operation ending.